.. _ocabitstringactuator:

1.1.1.1.13  OcaBitstringActuator
================================

Class Hierarchy:

:ref:`OcaRoot <ocaroot>` :raw:html:`&rarr;` :ref:`OcaWorker <ocaworker>` :raw:html:`&rarr;` :ref:`OcaActuator <ocaactuator>` :raw:html:`&rarr;` :ref:`OcaBasicActuator <ocabasicactuator>` :raw:html:`&rarr;` :ref:`OcaBitstringActuator <ocabitstringactuator>` 

.. cpp:class:: OcaBitstringActuator: OcaBasicActuator

    Bitstring actuator. Maximum bitstring length is 65,536 bits.

    **Properties**:

    .. _ocabitstringactuator_classid:

    .. cpp:member:: static const OcaClassID ClassID = "1.1.1.1.13"

        Number that uniquely identifies the class. Note that this differs from the object number, which identifies the instantiated object. This property is an override of the  **OcaRoot** property.

        This property has id ``5.1``.

    .. _ocabitstringactuator_classversion:

    .. cpp:member:: static const OcaClassVersionNumber ClassVersion = 2

        Identifies the interface version of the class. Any change to the class definition leads to a higher class version. This property is an override of the  **OcaRoot** property.

        This property has id ``5.2``.

    .. _ocabitstringactuator_bitstring:

    .. cpp:member:: OcaBitstring Bitstring

        The bitstring data.

        This property has id ``5.1``.

    Properties inherited from :ref:`OcaWorker <OcaWorker>`:
    
    - :cpp:texpr:`OcaBoolean` :ref:`OcaWorker::Enabled <OcaWorker_Enabled>`
    
    - :cpp:texpr:`OcaList<OcaPort>` :ref:`OcaWorker::Ports <OcaWorker_Ports>`
    
    - :cpp:texpr:`OcaString` :ref:`OcaWorker::Label <OcaWorker_Label>`
    
    - :cpp:texpr:`OcaONo` :ref:`OcaWorker::Owner <OcaWorker_Owner>`
    
    - :cpp:texpr:`OcaTimeInterval` :ref:`OcaWorker::Latency <OcaWorker_Latency>`
    
    
    Properties inherited from :ref:`OcaRoot <OcaRoot>`:
    
    - :cpp:texpr:`OcaONo` :ref:`OcaRoot::ObjectNumber <OcaRoot_ObjectNumber>`
    
    - :cpp:texpr:`OcaBoolean` :ref:`OcaRoot::Lockable <OcaRoot_Lockable>`
    
    - :cpp:texpr:`OcaString` :ref:`OcaRoot::Role <OcaRoot_Role>`
    
    

    **Methods**:

    .. _ocabitstringactuator_getnrbits:

    .. cpp:function:: OcaStatus GetNrBits(OcaUint16 &nrBits)

        Gets the number of bits in the string. The return value indicates whether the property was successfully gathered.

        This method has id ``5.1``.

        :param OcaUint16 nrBits: Output parameter.

    .. _ocabitstringactuator_getbit:

    .. cpp:function:: OcaStatus GetBit(OcaUint16 bitNr, OcaBoolean &Value)

        Gets the bit value of the given bit. The return value indicates whether the property was successfully gathered.

        This method has id ``5.2``.

        :param OcaUint16 bitNr: Input parameter.
        :param OcaBoolean Value: Output parameter.

    .. _ocabitstringactuator_setbit:

    .. cpp:function:: OcaStatus SetBit(OcaUint16 bitNr, OcaBoolean Value)

        Sets the bit value of the given bit. The return value indicates whether the property was successfully set.

        This method has id ``5.3``.

        :param OcaUint16 bitNr: Input parameter.
        :param OcaBoolean Value: Input parameter.

    .. _ocabitstringactuator_getbitstring:

    .. cpp:function:: OcaStatus GetBitstring(OcaBitstring &BitString)

        Gets the entire bitstring.The return value indicates whether the property was successfully gathered.

        This method has id ``5.4``.

        :param OcaBitstring BitString: Output parameter.

    .. _ocabitstringactuator_setbitstring:

    .. cpp:function:: OcaStatus SetBitstring(OcaBitstring BitString)

        Sets the entire bitstring. The return value indicates whether the property was successfully set.

        This method has id ``5.5``.

        :param OcaBitstring BitString: Input parameter.


    Methods inherited from :ref:`OcaWorker <OcaWorker>`:
    
    - :ref:`OcaWorker::GetEnabled(enabled) <OcaWorker_GetEnabled>`
    
    - :ref:`OcaWorker::SetEnabled(enabled) <OcaWorker_SetEnabled>`
    
    - :ref:`OcaWorker::AddPort(Label, Mode, ID) <OcaWorker_AddPort>`
    
    - :ref:`OcaWorker::DeletePort(ID) <OcaWorker_DeletePort>`
    
    - :ref:`OcaWorker::GetPorts(OcaPorts) <OcaWorker_GetPorts>`
    
    - :ref:`OcaWorker::GetPortName(PortID, Name) <OcaWorker_GetPortName>`
    
    - :ref:`OcaWorker::SetPortName(PortID, Name) <OcaWorker_SetPortName>`
    
    - :ref:`OcaWorker::GetLabel(label) <OcaWorker_GetLabel>`
    
    - :ref:`OcaWorker::SetLabel(label) <OcaWorker_SetLabel>`
    
    - :ref:`OcaWorker::GetOwner(owner) <OcaWorker_GetOwner>`
    
    - :ref:`OcaWorker::GetLatency(latency) <OcaWorker_GetLatency>`
    
    - :ref:`OcaWorker::SetLatency(latency) <OcaWorker_SetLatency>`
    
    - :ref:`OcaWorker::GetPath(NamePath, ONoPath) <OcaWorker_GetPath>`
    
    
    Methods inherited from :ref:`OcaRoot <OcaRoot>`:
    
    - :ref:`OcaRoot::GetClassIdentification(ClassIdentification) <OcaRoot_GetClassIdentification>`
    
    - :ref:`OcaRoot::GetLockable(lockable) <OcaRoot_GetLockable>`
    
    - :ref:`OcaRoot::LockTotal() <OcaRoot_LockTotal>`
    
    - :ref:`OcaRoot::Unlock() <OcaRoot_Unlock>`
    
    - :ref:`OcaRoot::GetRole(Role) <OcaRoot_GetRole>`
    
    - :ref:`OcaRoot::LockReadonly() <OcaRoot_LockReadonly>`